Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

ci: check for API changes in @digdir/designsystemet #2750

Draft
wants to merge 4 commits into
base: next
Choose a base branch
from
Draft

ci: check for API changes in @digdir/designsystemet #2750

wants to merge 4 commits into from
+994 −70

Conversation

unekinn
Copy link
Contributor

@unekinn unekinn commented Nov 8, 2024

No description provided.

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Nov 8, 2024 •
edited
Loading

⚠️ No Changeset found

Latest commit: a522cf7

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 8, 2024 •
edited
Loading

Preview deployments for this pull request:

Storybook - 8. Nov 2024 - 12:08

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 8, 2024 •
edited
Loading

Coverage Report

Status Category Percentage Covered / Total
🔵 Lines 53.9% 3067 / 5690
🔵 Statements 53.9% 3067 / 5690
🔵 Functions 85.85% 170 / 198
🔵 Branches 74.75% 459 / 614
File CoverageNo changed files found.
Generated in workflow #849 for commit a522cf7 by the Vitest Coverage Report Action

@unekinn unekinn changed the title ci: check for API changes in @digdir/designsystemet ci: check for API changes in @digdir/designsystemet Nov 8, 2024
mimarz
mimarz reviewed Nov 8, 2024
View reviewed changes
package.json Outdated Show resolved Hide resolved
mimarz
mimarz reviewed Nov 8, 2024
View reviewed changes
packages/cli/package.json Outdated Show resolved Hide resolved
@unekinn unekinn force-pushed the cli-api-report branch 2 times, most recently from 3d74093 to b5b3661 Compare November 8, 2024 10:31
@unekinn
Copy link
Contributor Author

unekinn commented Nov 8, 2024

@mimarz Here's an example of changing a part of the public API, and the resulting build error.
image

To update the api report in the repo, you would need to run yarn report:cli-api --local, get this diff
image

Then check it in and commit, thus making it obvious in the PR that the API has changed.

Question: I feel like the yarn report:cli-api --local command has to be documented. But where?

@unekinn
Copy link
Contributor Author

unekinn commented Nov 8, 2024

Checked that it works in CI 👍
image

@mimarz
Copy link
Collaborator

mimarz commented Nov 8, 2024

I haven't added a README file to the CLI yet, but I feel like its natural to something like that document there? #2732

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mimarz mimarz mimarz left review comments

@Barsnes Barsnes Awaiting requested review from Barsnes Barsnes will be requested when the pull request is marked ready for review Barsnes is a code owner

@eirikbacker eirikbacker Awaiting requested review from eirikbacker eirikbacker will be requested when the pull request is marked ready for review eirikbacker is a code owner

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@unekinn @mimarz